[%#
  # IMPORTANT NOTE
  #   This documentation is generated automatically from source
  #   templates.  Any changes you make here may be lost.
  # 
  #   The 'docsrc' documentation source bundle is available for download
  #   from http://www.template-toolkit.org/docs.html and contains all
  #   the source templates, XML files, scripts, etc., from which the
  #   documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
        page = 'Plugin_Dumper'
%]
[%  WRAPPER toc;
	PROCESS tocitem 
	        title ="SYNOPSIS"
                subs  = [];
	PROCESS tocitem 
	        title ="DESCRIPTION"
                subs  = [];
	PROCESS tocitem 
	        title ="METHODS"
                subs  = [
                    "dump()",
		    "dump_html()"
		];
	PROCESS tocitem 
	        title ="AUTHOR"
                subs  = [];
	PROCESS tocitem 
	        title ="VERSION"
                subs  = [];
	PROCESS tocitem 
	        title ="COPYRIGHT"
                subs  = [];
	PROCESS tocitem 
	        title ="SEE ALSO"
                subs  = [];
    END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
    title="SYNOPSIS"
-%]<pre>    [% tt_start_tag %] USE Dumper [% tt_end_tag %]</pre>
<pre>    [% tt_start_tag %] Dumper.dump(variable) [% tt_end_tag %]
    [% tt_start_tag %] Dumper.dump_html(variable) [% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
    title="DESCRIPTION"
-%]<p>
This is a very simple Template Toolkit Plugin Interface to the Data::Dumper
module.  A Dumper object will be instantiated via the following directive:
</p>
<pre>    [% tt_start_tag %] USE Dumper [% tt_end_tag %]</pre>
<p>
As a standard plugin, you can also specify its name in lower case:
</p>
<pre>    [% tt_start_tag %] USE dumper [% tt_end_tag %]</pre>
<p>
The Data::Dumper 'Pad', 'Indent' and 'Varname' options are supported
as constructor arguments to affect the output generated.  See [% ttlink('Data::Dumper') -%]
for further details.
</p>
<pre>    [% tt_start_tag %] USE dumper(Indent=0, Pad=&quot;&lt;br&gt;&quot;) [% tt_end_tag %]</pre>
<p>
These options can also be specified in lower case.
</p>
<pre>    [% tt_start_tag %] USE dumper(indent=0, pad=&quot;&lt;br&gt;&quot;) [% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
    title="METHODS"
-%]<p>
There are two methods supported by the Dumper object.  Each will
output into the template the contents of the variables passed to the
object method.
</p>
[% WRAPPER subsection
   title = "dump()"
-%]<p>
Generates a raw text dump of the data structure(s) passed
</p>
<pre>    [% tt_start_tag %] USE Dumper [% tt_end_tag %]
    [% tt_start_tag %] Dumper.dump(myvar) [% tt_end_tag %]
    [% tt_start_tag %] Dumper.dump(myvar, yourvar) [% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER subsection
   title = "dump_html()"
-%]<p>
Generates a dump of the data structures, as per dump(), but with the 
characters &lt;, &gt; and &amp; converted to their equivalent HTML
entities and newlines converted to &lt;br&gt;.
</p>
<pre>    [% tt_start_tag %] USE Dumper [% tt_end_tag %]
    [% tt_start_tag %] Dumper.dump_html(myvar) [% tt_end_tag %]</pre>
[%- END %]
[%- END %]
[% WRAPPER section
    title="AUTHOR"
-%]<p>
Simon Matthews &lt;sam@knowledgepool.com&gt;
</p>
[%- END %]
[% WRAPPER section
    title="VERSION"
-%]<p>
2.7, distributed as part of the
Template Toolkit version 2.19, released on 27 April 2007.
</p>
[%- END %]
[% WRAPPER section
    title="COPYRIGHT"
-%]<p>
Copyright (C) 2000 Simon Matthews All Rights Reserved.
</p>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
    title="SEE ALSO"
-%]<p>
[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('Data::Dumper', 'Data::Dumper') -%]
</p>
[%- END %]



